/*
 * Copyright 2024 The Backstage Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { createExtensionPoint } from '@backstage/backend-plugin-api';
import { Notification } from '@backstage/plugin-notifications-common';

/**
 * @public
 */
export interface NotificationProcessor {
  /**
   * Decorate notification before sending it
   *
   * @param notification - The notification to decorate
   * @returns The same notification or a modified version of it
   */
  decorate?(notification: Notification): Promise<Notification>;

  /**
   * Send notification using this processor.
   *
   * @param notification - The notification to send
   */
  send?(notification: Notification): Promise<void>;
}

/**
 * @public
 */
export interface NotificationsProcessingExtensionPoint {
  addProcessor(
    ...processors: Array<NotificationProcessor | Array<NotificationProcessor>>
  ): void;
}

/**
 * @public
 */
export const notificationsProcessingExtensionPoint =
  createExtensionPoint<NotificationsProcessingExtensionPoint>({
    id: 'notifications.processing',
  });
